<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements.  See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership.  The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License.  You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> *   http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied.  See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.commons.io.serialization;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.InputStream;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.InvalidClassException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.ObjectInputStream;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.ObjectStreamClass;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.ArrayList;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.regex.Pattern;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * An {@code ObjectInputStream} that's restricted to deserialize<a name="line.31"></a>
<span class="sourceLineNo">032</span> * a limited set of classes.<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Various accept/reject methods allow for specifying which classes<a name="line.35"></a>
<span class="sourceLineNo">036</span> * can be deserialized.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Design inspired by &lt;a<a name="line.40"></a>
<span class="sourceLineNo">041</span> * href="http://www.ibm.com/developerworks/library/se-lookahead/"&gt;IBM<a name="line.41"></a>
<span class="sourceLineNo">042</span> * DeveloperWorks Article&lt;/a&gt;.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;/p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class ValidatingObjectInputStream extends ObjectInputStream {<a name="line.45"></a>
<span class="sourceLineNo">046</span>    private final List&lt;ClassNameMatcher&gt; acceptMatchers = new ArrayList&lt;&gt;();<a name="line.46"></a>
<span class="sourceLineNo">047</span>    private final List&lt;ClassNameMatcher&gt; rejectMatchers = new ArrayList&lt;&gt;();<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>    /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * Constructs an object to deserialize the specified input stream.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * At least one accept method needs to be called to specify which<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * classes can be deserialized, as by default no classes are<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * accepted.<a name="line.53"></a>
<span class="sourceLineNo">054</span>     *<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @param input an input stream<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @throws IOException if an I/O error occurs while reading stream header<a name="line.56"></a>
<span class="sourceLineNo">057</span>     */<a name="line.57"></a>
<span class="sourceLineNo">058</span>    public ValidatingObjectInputStream(final InputStream input) throws IOException {<a name="line.58"></a>
<span class="sourceLineNo">059</span>        super(input);<a name="line.59"></a>
<span class="sourceLineNo">060</span>    }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>    /** Check that the classname conforms to requirements.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * @param name The class name<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @throws InvalidClassException when a non-accepted class is encountered<a name="line.64"></a>
<span class="sourceLineNo">065</span>     */<a name="line.65"></a>
<span class="sourceLineNo">066</span>    private void validateClassName(final String name) throws InvalidClassException {<a name="line.66"></a>
<span class="sourceLineNo">067</span>        // Reject has precedence over accept<a name="line.67"></a>
<span class="sourceLineNo">068</span>        for (final ClassNameMatcher m : rejectMatchers) {<a name="line.68"></a>
<span class="sourceLineNo">069</span>            if (m.matches(name)) {<a name="line.69"></a>
<span class="sourceLineNo">070</span>                invalidClassNameFound(name);<a name="line.70"></a>
<span class="sourceLineNo">071</span>            }<a name="line.71"></a>
<span class="sourceLineNo">072</span>        }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>        boolean ok = false;<a name="line.74"></a>
<span class="sourceLineNo">075</span>        for (final ClassNameMatcher m : acceptMatchers) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>            if (m.matches(name)) {<a name="line.76"></a>
<span class="sourceLineNo">077</span>                ok = true;<a name="line.77"></a>
<span class="sourceLineNo">078</span>                break;<a name="line.78"></a>
<span class="sourceLineNo">079</span>            }<a name="line.79"></a>
<span class="sourceLineNo">080</span>        }<a name="line.80"></a>
<span class="sourceLineNo">081</span>        if (!ok) {<a name="line.81"></a>
<span class="sourceLineNo">082</span>            invalidClassNameFound(name);<a name="line.82"></a>
<span class="sourceLineNo">083</span>        }<a name="line.83"></a>
<span class="sourceLineNo">084</span>    }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>    /**<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * Called to throw {@code InvalidClassException} if an invalid<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * class name is found during deserialization. Can be overridden, for example<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * to log those class names.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     *<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @param className name of the invalid class<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @throws InvalidClassException if the specified class is not allowed<a name="line.92"></a>
<span class="sourceLineNo">093</span>     */<a name="line.93"></a>
<span class="sourceLineNo">094</span>    protected void invalidClassNameFound(final String className) throws InvalidClassException {<a name="line.94"></a>
<span class="sourceLineNo">095</span>        throw new InvalidClassException("Class name not accepted: " + className);<a name="line.95"></a>
<span class="sourceLineNo">096</span>    }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>    @Override<a name="line.98"></a>
<span class="sourceLineNo">099</span>    protected Class&lt;?&gt; resolveClass(final ObjectStreamClass osc) throws IOException, ClassNotFoundException {<a name="line.99"></a>
<span class="sourceLineNo">100</span>        validateClassName(osc.getName());<a name="line.100"></a>
<span class="sourceLineNo">101</span>        return super.resolveClass(osc);<a name="line.101"></a>
<span class="sourceLineNo">102</span>    }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>    /**<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * Accept the specified classes for deserialization, unless they<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * are otherwise rejected.<a name="line.106"></a>
<span class="sourceLineNo">107</span>     *<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @param classes Classes to accept<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @return this object<a name="line.109"></a>
<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
<span class="sourceLineNo">111</span>    public ValidatingObjectInputStream accept(final Class&lt;?&gt;... classes) {<a name="line.111"></a>
<span class="sourceLineNo">112</span>        for (final Class&lt;?&gt; c : classes) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>            acceptMatchers.add(new FullClassNameMatcher(c.getName()));<a name="line.113"></a>
<span class="sourceLineNo">114</span>        }<a name="line.114"></a>
<span class="sourceLineNo">115</span>        return this;<a name="line.115"></a>
<span class="sourceLineNo">116</span>    }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>    /**<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * Reject the specified classes for deserialization, even if they<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * are otherwise accepted.<a name="line.120"></a>
<span class="sourceLineNo">121</span>     *<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * @param classes Classes to reject<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * @return this object<a name="line.123"></a>
<span class="sourceLineNo">124</span>     */<a name="line.124"></a>
<span class="sourceLineNo">125</span>    public ValidatingObjectInputStream reject(final Class&lt;?&gt;... classes) {<a name="line.125"></a>
<span class="sourceLineNo">126</span>        for (final Class&lt;?&gt; c : classes) {<a name="line.126"></a>
<span class="sourceLineNo">127</span>            rejectMatchers.add(new FullClassNameMatcher(c.getName()));<a name="line.127"></a>
<span class="sourceLineNo">128</span>        }<a name="line.128"></a>
<span class="sourceLineNo">129</span>        return this;<a name="line.129"></a>
<span class="sourceLineNo">130</span>    }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>    /**<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * Accept the wildcard specified classes for deserialization,<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * unless they are otherwise rejected.<a name="line.134"></a>
<span class="sourceLineNo">135</span>     *<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * @param patterns Wildcard file name patterns as defined by<a name="line.136"></a>
<span class="sourceLineNo">137</span>     *                  {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String) FilenameUtils.wildcardMatch}<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * @return this object<a name="line.138"></a>
<span class="sourceLineNo">139</span>     */<a name="line.139"></a>
<span class="sourceLineNo">140</span>    public ValidatingObjectInputStream accept(final String... patterns) {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        for (final String pattern : patterns) {<a name="line.141"></a>
<span class="sourceLineNo">142</span>            acceptMatchers.add(new WildcardClassNameMatcher(pattern));<a name="line.142"></a>
<span class="sourceLineNo">143</span>        }<a name="line.143"></a>
<span class="sourceLineNo">144</span>        return this;<a name="line.144"></a>
<span class="sourceLineNo">145</span>    }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>    /**<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * Reject the wildcard specified classes for deserialization,<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * even if they are otherwise accepted.<a name="line.149"></a>
<span class="sourceLineNo">150</span>     *<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * @param patterns Wildcard file name patterns as defined by<a name="line.151"></a>
<span class="sourceLineNo">152</span>     *                  {@link org.apache.commons.io.FilenameUtils#wildcardMatch(String, String) FilenameUtils.wildcardMatch}<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @return this object<a name="line.153"></a>
<span class="sourceLineNo">154</span>     */<a name="line.154"></a>
<span class="sourceLineNo">155</span>    public ValidatingObjectInputStream reject(final String... patterns) {<a name="line.155"></a>
<span class="sourceLineNo">156</span>        for (final String pattern : patterns) {<a name="line.156"></a>
<span class="sourceLineNo">157</span>            rejectMatchers.add(new WildcardClassNameMatcher(pattern));<a name="line.157"></a>
<span class="sourceLineNo">158</span>        }<a name="line.158"></a>
<span class="sourceLineNo">159</span>        return this;<a name="line.159"></a>
<span class="sourceLineNo">160</span>    }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span>    /**<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * Accept class names that match the supplied pattern for<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * deserialization, unless they are otherwise rejected.<a name="line.164"></a>
<span class="sourceLineNo">165</span>     *<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * @param pattern standard Java regexp<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * @return this object<a name="line.167"></a>
<span class="sourceLineNo">168</span>     */<a name="line.168"></a>
<span class="sourceLineNo">169</span>    public ValidatingObjectInputStream accept(final Pattern pattern) {<a name="line.169"></a>
<span class="sourceLineNo">170</span>        acceptMatchers.add(new RegexpClassNameMatcher(pattern));<a name="line.170"></a>
<span class="sourceLineNo">171</span>        return this;<a name="line.171"></a>
<span class="sourceLineNo">172</span>    }<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span>    /**<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * Reject class names that match the supplied pattern for<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * deserialization, even if they are otherwise accepted.<a name="line.176"></a>
<span class="sourceLineNo">177</span>     *<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * @param pattern standard Java regexp<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * @return this object<a name="line.179"></a>
<span class="sourceLineNo">180</span>     */<a name="line.180"></a>
<span class="sourceLineNo">181</span>    public ValidatingObjectInputStream reject(final Pattern pattern) {<a name="line.181"></a>
<span class="sourceLineNo">182</span>        rejectMatchers.add(new RegexpClassNameMatcher(pattern));<a name="line.182"></a>
<span class="sourceLineNo">183</span>        return this;<a name="line.183"></a>
<span class="sourceLineNo">184</span>    }<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>
<span class="sourceLineNo">186</span>    /**<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * Accept class names where the supplied ClassNameMatcher matches for<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * deserialization, unless they are otherwise rejected.<a name="line.188"></a>
<span class="sourceLineNo">189</span>     *<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * @param m the matcher to use<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * @return this object<a name="line.191"></a>
<span class="sourceLineNo">192</span>     */<a name="line.192"></a>
<span class="sourceLineNo">193</span>    public ValidatingObjectInputStream accept(final ClassNameMatcher m) {<a name="line.193"></a>
<span class="sourceLineNo">194</span>        acceptMatchers.add(m);<a name="line.194"></a>
<span class="sourceLineNo">195</span>        return this;<a name="line.195"></a>
<span class="sourceLineNo">196</span>    }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span>    /**<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * Reject class names where the supplied ClassNameMatcher matches for<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * deserialization, even if they are otherwise accepted.<a name="line.200"></a>
<span class="sourceLineNo">201</span>     *<a name="line.201"></a>
<span class="sourceLineNo">202</span>     * @param m the matcher to use<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * @return this object<a name="line.203"></a>
<span class="sourceLineNo">204</span>     */<a name="line.204"></a>
<span class="sourceLineNo">205</span>    public ValidatingObjectInputStream reject(final ClassNameMatcher m) {<a name="line.205"></a>
<span class="sourceLineNo">206</span>        rejectMatchers.add(m);<a name="line.206"></a>
<span class="sourceLineNo">207</span>        return this;<a name="line.207"></a>
<span class="sourceLineNo">208</span>    }<a name="line.208"></a>
<span class="sourceLineNo">209</span>}<a name="line.209"></a>




























































</pre>
</div>
</body>
</html>
